Add `unbind-default-keys` config option #2733

Lindenk · 2022-06-10T04:08:35Z

Closes #2720.

There were a few changes I made to reduce confusion with some function/method locations and naming:

helix_term::keymap::merge_keys was moved to helix_term::config::Config::merge_keys as a method because it only operates on and changes Config, and was modified to take a set of bindings to merge with itself. New functions were also added to handle the new optional behavior.
Config::load now is the single source of truth for loading and merging configs, which was previously also handled in helix_term::application::new in a slightly different but mostly redundant manner.
Default is removed from Config and replaced with Config::new and Config::with_default_keys. new returns a Config with no bindings while with_default_keys returns a Config with the default bindings (which is the same behavior as the old default). This to prevent confusion between a default rust struct and helix's default keybindings as these terms were previously conflated.
Config::keys no longer loads default bindings through serde when no keys are found as this was always redundant.
helix_term::keymap::Keymaps::get no longer crashes when a mode isn't found. This will also help with future mode additions (likely through plugins down the line).

Let me know if any of these changes should be handled differently

EDIT: After updating to a much newer version of helix, this PR only adds the new option unbind_default_keys which does not populate the initial keymap at all. This also includes the fix where Helix would crash if a keybind for a non-existent mode is triggered

the-mikedavis · 2022-06-10T16:21:07Z

Could you add some notes on using this to the docs? https://github.com/helix-editor/helix/tree/f37ffaa3a1c7754238029390db00148ec8105874/book/src

Lindenk · 2022-06-10T16:41:02Z

No problem. If you'd like me to include a new subsection or larger blurb, or if there's a better place to provide this specific documentation, let me know

sudormrfbin

How about renaming the config option to unbind_default_keys ?

helix-term/src/config.rs

book/src/remapping.md

helix-term/src/application.rs

helix-term/src/config.rs

helix-term/src/keymap.rs

helix-term/src/config.rs

book/src/remapping.md

patrick-kidger · 2022-11-10T17:51:02Z

Is there any movement on this? I'd really like to try out this feature.

…sion of helix

Lindenk · 2023-05-04T01:55:27Z

I updated the feature to the current version of helix and addressed the above changes. Now it only adds the config option unbind_default_keys

ref: helix-editor#2733

ref: helix-editor/helix#2720 ref: helix-editor/helix#2733 Co-authored-by: Linden Krouse <[email protected]>

Based on helix-editor#2733

* Add `unbind_default_keys` config option Based on helix-editor#2733 * Fix lint issues

Based on helix-editor#2733

shaleh · 2024-04-18T21:21:39Z

helix-term/src/config.rs

+                let mut keys;
+                match config.unbind_default_keys {
+                    true => keys = HashMap::default(),
+                    false => keys = keymap::default(),
+                }


Suggested change

let mut keys;

match config.unbind_default_keys {

true => keys = HashMap::default(),

false => keys = keymap::default(),

}

let mut keys = match config.unbind_default_keys {

true => HashMap::default(),

false => keymap::default(),

};

shaleh · 2024-04-18T21:22:26Z

helix-term/src/config.rs

+                let mut keys;
+                match local.unbind_default_keys {
+                    true => keys = HashMap::default(),
+                    false => keys = keymap::default(),
+                }


Suggested change

let mut keys;

match local.unbind_default_keys {

true => keys = HashMap::default(),

false => keys = keymap::default(),

}

let mut keys = match local.unbind_default_keys {

true => HashMap::default(),

false => keymap::default(),

};

shaleh · 2024-04-18T21:24:28Z

helix-term/src/keymap.rs

+        let keymap = match keymaps.get(&mode) {
+            Some(keymap) => keymap,
+            None => return KeymapResult::NotFound,
+        };


Suggested change

let keymap = match keymaps.get(&mode) {

Some(keymap) => keymap,

None => return KeymapResult::NotFound,

};

let Some(keymap) = keymaps.get(&mode) else { return KeymapResult::NotFound; };

This is the style used elsewhere in the code.

the-mikedavis · 2024-04-19T00:30:25Z

#9384 (comment), #2720 (comment) - we want to solve this when we switch config away from TOML rather than adding a new config option now

Based on helix-editor#2733

ref: helix-editor/helix#2720 ref: helix-editor/helix#2733

sudormrfbin reviewed Jun 10, 2022

View reviewed changes

helix-term/src/config.rs Outdated Show resolved Hide resolved

book/src/remapping.md Outdated Show resolved Hide resolved

Lindenk requested a review from sudormrfbin June 16, 2022 01:03

Lindenk force-pushed the feature/unbind-keybinds branch from cd3dc9c to d0f2c2f Compare June 22, 2022 02:23

sudormrfbin reviewed Jun 23, 2022

View reviewed changes

Lindenk requested a review from sudormrfbin June 30, 2022 05:02

p-e-w mentioned this pull request Aug 13, 2022

Make initial editing mode configurable #3366

Closed

kirawi added A-helix-term Area: Helix term improvements S-waiting-on-review Status: Awaiting review from a maintainer. labels Sep 13, 2022

the-mikedavis reviewed Oct 15, 2022

View reviewed changes

helix-term/src/config.rs Outdated Show resolved Hide resolved

the-mikedavis changed the title ~~Added unbind_defaults config option~~ Add unbind-default-keys config option Oct 15, 2022

the-mikedavis force-pushed the feature/unbind-keybinds branch from 86caa8b to cc60238 Compare October 15, 2022 21:12

the-mikedavis reviewed Oct 15, 2022

View reviewed changes

helix-term/src/keymap.rs Outdated Show resolved Hide resolved

helix-term/src/keymap.rs Outdated Show resolved Hide resolved

helix-term/src/config.rs Outdated Show resolved Hide resolved

book/src/remapping.md Outdated Show resolved Hide resolved

the-mikedavis added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from a maintainer. labels Oct 16, 2022

pascalkuthe added S-inactive Status: Inactive and waiting on the author. This is often applied to closed PRs. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Feb 1, 2023

Lindenk added 2 commits May 3, 2023 21:43

Readded the ability to remove default keybindings for the current ver…

f28f654

…sion of helix

Added docs

8ecb962

Lindenk force-pushed the feature/unbind-keybinds branch from cc60238 to 8ecb962 Compare May 4, 2023 01:46

Lindenk requested a review from the-mikedavis May 4, 2023 02:00

the-mikedavis added S-waiting-on-review Status: Awaiting review from a maintainer. and removed S-inactive Status: Inactive and waiting on the author. This is often applied to closed PRs. labels May 4, 2023

omentic added a commit to omentic/helix that referenced this pull request Jul 16, 2023

Add unbind-default-keys config option

4525800

ref: helix-editor#2733

omentic added a commit to omentic/helix-ext that referenced this pull request Nov 1, 2023

Add unbind-default-keys config option

7260812

ref: helix-editor/helix#2720 ref: helix-editor/helix#2733 Co-authored-by: Linden Krouse <[email protected]>

postsolar added a commit to postsolar/helix that referenced this pull request Jan 19, 2024

Add unbind_default_keys config option

c838f9c

Based on helix-editor#2733

postsolar mentioned this pull request Jan 19, 2024

Add unbind_default_keys config option #9384

Closed

postsolar added a commit to postsolar/helix that referenced this pull request Jan 19, 2024

Add unbind_default_keys config option (#1)

20b7d8e

* Add `unbind_default_keys` config option Based on helix-editor#2733 * Fix lint issues

postsolar added a commit to postsolar/helix that referenced this pull request Apr 4, 2024

Add unbind_default_keys config option

5b6049b

Based on helix-editor#2733

postsolar added a commit to postsolar/helix that referenced this pull request Apr 4, 2024

Add unbind_default_keys config option

94192c4

Based on helix-editor#2733

postsolar added a commit to postsolar/helix that referenced this pull request Apr 6, 2024

Add unbind_default_keys config option

63bafa2

Based on helix-editor#2733

postsolar added a commit to postsolar/helix that referenced this pull request Apr 11, 2024

Add unbind_default_keys config option

a35e16f

Based on helix-editor#2733

shaleh reviewed Apr 18, 2024

View reviewed changes

the-mikedavis closed this Apr 19, 2024

postsolar added a commit to postsolar/helix that referenced this pull request Apr 20, 2024

Add unbind_default_keys config option

4e2dac5

Based on helix-editor#2733

omentic pushed a commit to omentic/helix-ext that referenced this pull request May 1, 2024

Add unbind-default-keys config option

5f861d3

ref: helix-editor/helix#2720 ref: helix-editor/helix#2733

omentic pushed a commit to omentic/helix-ext that referenced this pull request May 1, 2024

Add unbind-default-keys config option

0a08d7e

ref: helix-editor/helix#2720 ref: helix-editor/helix#2733

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `unbind-default-keys` config option #2733

Add `unbind-default-keys` config option #2733

Lindenk commented Jun 10, 2022 •

edited

Loading

the-mikedavis commented Jun 10, 2022

Lindenk commented Jun 10, 2022

sudormrfbin left a comment

patrick-kidger commented Nov 10, 2022

Lindenk commented May 4, 2023

shaleh Apr 18, 2024

shaleh Apr 18, 2024

shaleh Apr 18, 2024

the-mikedavis commented Apr 19, 2024

Add unbind-default-keys config option #2733

Add unbind-default-keys config option #2733

Conversation

Lindenk commented Jun 10, 2022 • edited Loading

the-mikedavis commented Jun 10, 2022

Lindenk commented Jun 10, 2022

sudormrfbin left a comment

Choose a reason for hiding this comment

patrick-kidger commented Nov 10, 2022

Lindenk commented May 4, 2023

shaleh Apr 18, 2024

Choose a reason for hiding this comment

shaleh Apr 18, 2024

Choose a reason for hiding this comment

shaleh Apr 18, 2024

Choose a reason for hiding this comment

the-mikedavis commented Apr 19, 2024

Add `unbind-default-keys` config option #2733

Add `unbind-default-keys` config option #2733

Lindenk commented Jun 10, 2022 •

edited

Loading